<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream::read_some (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../read_some.html" title="basic_stream::read_some">
<link rel="prev" href="../read_some.html" title="basic_stream::read_some">
<link rel="next" href="overload2.html" title="basic_stream::read_some (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read_some.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__basic_stream.read_some.overload1"></a><a class="link" href="overload1.html" title="basic_stream::read_some (1 of 2 overloads)">basic_stream::read_some
          (1 of 2 overloads)</a>
</h6></div></div></div>
<p>
            Read some data.
          </p>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/MutableBufferSequence.html" target="_top"><span class="emphasis"><em>MutableBufferSequence</em></span></a><span class="special">&gt;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
<span class="identifier">read_some</span><span class="special">(</span>
    <span class="identifier">MutableBufferSequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">buffers</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.description">Description</a>
          </h7><p>
            This function is used to read some data from the stream. The call blocks
            until one of the following is true:
          </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                One or more bytes are read from the stream.
              </li>
<li class="listitem">
                An error occurs.
              </li>
</ul></div>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">buffers</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The buffers into which the data will be read. If the size of
                      the buffers is zero bytes, the call always returns immediately
                      with no error.
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h3"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.return_value"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.return_value">Return
            Value</a>
          </h7><p>
            The number of bytes read.
          </p>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h4"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.exceptions">Exceptions</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Thrown On
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">system_error</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Thrown on failure.
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.h5"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.read_some.overload1.remarks"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__basic_stream.read_some.overload1.remarks">Remarks</a>
          </h7><p>
            The <code class="computeroutput"><span class="identifier">read_some</span></code> operation
            may not receive all of the requested number of bytes. Consider using
            the function <a class="link" href="../../boost__beast__file_mode.html" title="file_mode"><code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">read</span></code></a> if you need to ensure that
            the requested amount of data is read before the blocking operation completes.
          </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../read_some.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../read_some.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
